Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jul 1, 2025

Link issues

fixes #6332

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Fix OnCloseAsync callback invocation for multiple stacked dialogs by storing callbacks in the dialog parameters and invoking them upon each dialog removal.

Bug Fixes:

  • Ensure OnCloseAsync is triggered for every dialog in multi-dialog scenarios

Enhancements:

  • Extend DialogParameters to include OnCloseCallback for each dialog instance
  • Use dictionary removal with out parameter to retrieve and invoke the correct callback on dialog close

@bb-auto bb-auto bot added the bug Something isn't working label Jul 1, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jul 1, 2025

Reviewer's Guide

Refactors the Dialog component to store each dialog’s OnCloseAsync callback alongside its display parameters and invoke it only after the specific dialog is removed, ensuring callbacks are not triggered multiple times when multiple dialogs are open.

Sequence diagram for OnCloseAsync invocation with multiple dialogs

sequenceDiagram
    participant User as actor User
    participant Dialog
    participant DialogParameters
    participant OnCloseCallback as OnCloseAsync Callback

    User->>Dialog: Close a dialog
    Dialog->>DialogParameters: Remove _currentParameter
    DialogParameters-->>Dialog: Return (IsKeyboard, IsBackdrop, OnCloseCallback)
    alt OnCloseCallback exists
        Dialog->>OnCloseCallback: Invoke OnCloseCallback()
    end
    Dialog->>DialogParameters: Get last dialog (if any)
    Dialog->>Dialog: Update _currentParameter, _isKeyboard, _isBackdrop
    Dialog->>Dialog: StateHasChanged()
Loading

Class diagram for updated DialogParameters structure in Dialog component

classDiagram
    class Dialog {
        - Dictionary<Dictionary<string, object>, (bool IsKeyboard, bool IsBackdrop, Func<Task>? OnCloseCallback)> DialogParameters
        - Dictionary<string, object>? _currentParameter
        - bool _isKeyboard
        - bool _isBackdrop
        - Func<Task>? _onCloseAsync
        + Task Show(DialogOption option)
    }
    class DialogOption {
        + Func<Task>? OnCloseAsync
    }
Loading

File-Level Changes

Change Details Files
Enhanced storage structure for dialog parameters
  • Added Func? OnCloseCallback to the tuple signature
  • Updated DialogParameters declaration to include the callback
  • Adapted parameter storage to keep the close callback per dialog instance
src/BootstrapBlazor/Components/Dialog/Dialog.razor.cs
Revised dialog removal logic to invoke per-dialog callbacks
  • Switched from simple Remove(key) to Remove(key, out var value) overload
  • Added conditional invocation of value.OnCloseCallback after removal
  • Preserved multiple-dialog support by fetching the last remaining parameters
src/BootstrapBlazor/Components/Dialog/Dialog.razor.cs
Removed inline callback invocation in Show method
  • Deleted direct await of option.OnCloseAsync inside _onCloseAsync
  • Centralized callback execution to the new removal logic
src/BootstrapBlazor/Components/Dialog/Dialog.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6332 When using multiple dialogs, ensure that the OnCloseAsync callback is triggered for each dialog upon closing.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added this to the 9.8.0 milestone Jul 1, 2025
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes and they look great!

Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `src/BootstrapBlazor/Components/Dialog/Dialog.razor.cs:78` </location>
<code_context>
             if (_currentParameter != null)
             {
-                DialogParameters.Remove(_currentParameter);
+                DialogParameters.Remove(_currentParameter, out var v);
+                if (v.OnCloseCallback != null)
+                {
+                    await v.OnCloseCallback();
</code_context>

<issue_to_address>
Potential null reference if Remove fails to find the key.

Consider logging a warning if _currentParameter is not found in DialogParameters, as Remove returning false may indicate unexpected behavior.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
            if (_currentParameter != null)
            {
                DialogParameters.Remove(_currentParameter, out var v);
                if (v.OnCloseCallback != null)
                {
                    await v.OnCloseCallback();
                }
=======
            if (_currentParameter != null)
            {
                if (DialogParameters.Remove(_currentParameter, out var v))
                {
                    if (v.OnCloseCallback != null)
                    {
                        await v.OnCloseCallback();
                    }
                }
                else
                {
                    // Log a warning if _currentParameter is not found
                    Logger?.LogWarning($"DialogParameters did not contain the key: {_currentParameter}");
                }
>>>>>>> REPLACE

</suggested_fix>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Jul 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (f8d6acc) to head (3144b03).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6339   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          717       717           
  Lines        31573     31571    -2     
  Branches      4461      4461           
=========================================
- Hits         31573     31571    -2     
Flag Coverage Δ
BB 100.00% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ArgoZhang ArgoZhang enabled auto-merge (squash) July 1, 2025 05:19
@ArgoZhang ArgoZhang merged commit a408e98 into main Jul 1, 2025
5 checks passed
@ArgoZhang ArgoZhang deleted the chore-dialog branch July 1, 2025 05:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug(Dialog): 多级弹窗时只有最后一个 OnCloseAsync 起效

2 participants